<?php
/**
 * 11abacus Framework's module interface declaration
 *
 * PHP version 5
 *
 * LICENSE:
 *
 * Copyright (c) 2008, 11abacus / Philippe Jausions
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   - Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   - Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   - Neither the name of the 11abacus nor the names of its contributors may
 *     be used to endorse or promote products derived from this software
 *     without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @category  Framework
 * @package   Abacus11_Framework
 * @author    Philippe Jausions <Philippe.Jausions@11abacus.com>
 * @copyright 2008 11abacus / Philippe Jausions
 * @license   http://www.opensource.org/licenses/bsd-license.php New BSD
 * @link      http://pear.11abacus.com/package/Abacus11_Framework
 */

/**
 * 11abacus Framework's module interface declaration
 *
 * @category  Framework
 * @package   Abacus11_Framework
 * @author    Philippe Jausions <Philippe.Jausions@11abacus.com>
 * @copyright 2008 11abacus / Philippe Jausions
 * @license   http://www.opensource.org/licenses/bsd-license.php New BSD
 * @link      http://pear.11abacus.com/package/Abacus11_Framework
 */
interface Abacus11_Framework_ModuleInterface
{
    /**
     * Returns the availability status 
     *
     * @param string                     $action  Action name
     * @param object                     $user    User
     * @param Abacus11_Framework_Request $request Request
     * 
     * @return Abacus11_Framework::STATUS_* status constant
     */
    public function getStatus($action = null, $user = null, $request = null);

    /**
     * Returns a response object for the given status, action and/or user
     *
     * @param Abacus11_Framework::STATUS_* $status status constant
     * @param string                       $action action name
     * @param object                       $user   User
     * @param Abacus11_Framework_Request   $request Request
     * 
     * @return Abacus11_Framework_Response response instance
     */
    public function getResponse($status, $action, $user, $request);

    /**
     * Returns the name of the module
     *
     * @return string
     */
    public function getName();

    /**
     * Returns the controller instance that spawn the module
     *
     * @return Abacus11_Framework_Controller
     */
    public function getController();

    /**
     * Sets the controller instance that spawn the module
     *
     * @param Abacus11_Framework_Controller $controller the controller instance
     * 
     * @return void
     */
    public function setController(Abacus11_Framework_Controller $controller);
}

?>